// 
// Entify project
//  
// Author:
//       Lauri Taimila <lauri@taimila.com>
// 
// Copyright (c) 2010 Lauri Taimila
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;

namespace Taimila.Entify
{
	/// <summary>
	/// TypeCoordinator's responsibility is to know all entity types
	/// stored into the persistent store. It keeps book of entity types 
	/// and their versions. It also adds and updates types as needed.
	/// </summary>
	internal interface ITypeCoordinator
	{		
		/// <summary>
		/// Checks is given object type of any known entity type.
		/// </summary>
		/// <param name="type">
		/// Type to be checked. <see cref="System.Type"/>
		/// </param>
		/// <returns>
		/// True if it's known type, otherwise false. <see cref="System.Boolean"/>
		/// </returns>
		bool IsKnownType(Type type);
		
		/// <summary>
		/// Checks is type's entity version is same as the currently known
		/// version of the entity type. 
		/// </summary>
		/// <param name="type">
		/// Type to be checked. <see cref="System.Type"/>
		/// </param>
		/// <returns>
		/// True if object is known version, otherwise false. <see cref="System.Boolean"/>
		/// </returns>
		bool IsCurrentVersion(Type type);
		
		/// <summary>
		/// Adds new type to the persistent store.
		/// </summary>
		/// <param name="type">
		/// Type to be added. <see cref="System.Type"/>
		/// </param>
		void AddType(Type type);

		/// <summary>
		/// Mark relation between given types with given relation name.
		/// </summary>
		/// <param name="relatedType">
		/// Entity type that is related from another entity type. <see cref="Type"/>
		/// </param>
		/// <param name="relatingType">
		/// Entity type that has relation to related type. <see cref="Type"/>
		/// </param>
		/// <param name="relationPropertyName">
		/// Name of the relation property on relating type. <see cref="System.String"/>
		/// </param>
		void MarkAsRelatedType(Type relatedType, Type relatingType, string relationPropertyName);
		
		/// <summary>
		/// Updates existing entity type.
		/// </summary>
		/// <param name="type">
		/// Type to be updated. <see cref="System.Type"/>
		/// </param>
		void UpdateType(Type type);
	}
}
